home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / sfwwivdr.zip / SFWWIVDR.DOC < prev   
Text File  |  1990-11-17  |  11KB  |  237 lines
  1.                                    SFWWIVDR
  2.                    WWIV Door To SPITFIRE Conversion Program     
  3.                                 Version 1.1  
  4.                        Copyright (C) By Mike Woltz, 1990
  5.                              Buffalo Creek Software
  6.                                   A Member Of 
  7.                    The Association Of Shareware Professionals
  8.  
  9.  
  10.  
  11.     INTRODUCTION
  12.     ------------  
  13.      
  14.        SFWWIVDR is a utility written by Mike Woltz, author of SPITFIRE, to
  15.     enable WWIV door programs to be used with SPITFIRE.  Using SFWWIVDR
  16.     you may setup the WWIV door program to be used either as a SPITFIRE
  17.     door or as a sysop configurable command from the SPITFIRE Main, Message
  18.     or File menus.
  19.    
  20.    
  21.     HOW IT WORKS 
  22.     ------------
  23.     
  24.        It is recommended SFWWIVDR.COM be placed in the main SPITFIRE file
  25.     directory.  All examples in this documentation will make the assumption
  26.     that SFWWIVDR is being run from the C:\SF directory, with the system
  27.     files of SPITFIRE also residing in this directory.  It is necessary for
  28.     SFWWIVDR to access other files which are required for the proper
  29.     execution of SFWWIVDR.
  30.            
  31.        SFWWIVDR uses a command line parameter to determine the drive
  32.     and directory where the WWIV door program files exist and the placement
  33.     of CHAIN.TXT.  CHAIN.TXT is the equivalent to WWIV as what SFDOORS.DAT
  34.     is to SPITFIRE.  So in other words, if SPITFIRE is being run from the 
  35.     SF directory of drive C and a DOOR_A directory was created from the SF 
  36.     directory for the WWIV door program files your command line would 
  37.     look like this:
  38.     
  39.     SFWWIVDR C:\SF\DOOR_A
  40.     
  41.     If no command line parameter is used specifying the drive and the
  42.     directory for placement of the CHAIN.TXT file, SFWWIVDR will not run.
  43.     Please note, the file name (CHAIN.TXT) is not included in the command
  44.     line parameter!
  45.     
  46.        When SFWWIVDR is executed it first will check for the SFDOORS.DAT file.
  47.     If this is found, this signifies that the WWIV door program has been
  48.     set up to run as a SPITFIRE door.  If this is not found, it continues
  49.     to look for SFMAIN.DAT, SFFILE.DAT or SFMESS.DAT, in the order listed.  
  50.     If one of these files are found it signifies the WWIV door program 
  51.     is being run as a sysop configurable command from the corresponding menu.  
  52.     This allows SFWWIVDR to determine which batch file will be used to run the
  53.     WWIV door program.  If none of the above mentioned DAT files are
  54.     found SFWWIVDR will beep and halt program execution.
  55.     
  56.        SFWWIVDR will then read and obtain information from the SFNODE.DAT,
  57.     SFUSERS.DAT, and SFSYSTEM.DAT, in the order listed.  If any of these
  58.     files are not found SFWWIVDR will beep and halt program execution.
  59.     The information obtained from these files is used to create CHAIN.TXT.
  60.     CHAIN.TXT is a data file used with WWIV door programs.  CHAIN.TXT is then
  61.     written to the directory you specified earlier in the command line
  62.     parameter.  
  63.     
  64.     ***IMPORTANT NOTE***
  65.        It should also be mentioned that when creating CHAIN.TXT, lines
  66.     17 and 18 of this file require a drive and directory name.  The
  67.     drive and directory from which SFWWIVDR is being executed defaults
  68.     into these lines.  In this example this would be C:\SF.  This is
  69.     important to know because if the WWIV door you are using attempts to
  70.     write to or read from any WWIV BBS system files, it will not work
  71.     properly because the WWIV system files will not be found.
  72.     
  73.     
  74.     USING SFWWIVDR TO RUN A SPITFIRE DOOR
  75.     -------------------------------------
  76.        
  77.        The first thing you will need to be concerned with when using
  78.     SFWWIVDR to run a SPITFIRE door will be to create or modify an existing
  79.     SFDOOR.MNU.  Using your favorite text editor you will need to
  80.     include a line that contains a brief description of the door program
  81.     you intend to run, a comma, and the security level required by the
  82.     user to access this SPITFIRE door.  (The line number should correspond 
  83.     to the door number you are running your door program in.  For this 
  84.     example we will be using Door number 1.  For more detailed information 
  85.     refer to the SPITFIRE manual.)  A typical line of your SFDOOR.MNU might
  86.     look like this:
  87.     
  88.     The Door Description,10
  89.     
  90.     If you are using SFDR[x].BBS/CLR sysop created non-ansi and ansi
  91.     menus these will need to be modified also.
  92.     
  93.        Next you will also need to modify your SF.BAT file with your 
  94.     favorite text editor.  Locate the line which contains :DOOR_A.
  95.     You will need to place your door #1 commands (valid DOS commands,
  96.     program execution, etc.) between :DOOR_A and GOTO LOOP.  A typical
  97.     example of this portion of your SF.BAT might be changed to read as
  98.     listed below:
  99.     
  100.          :DOOR_A
  101.          SFWWIVDR C:\SF\DOOR_A
  102.          CD\SF\DOOR_A
  103.          PROGRAM NAME  
  104.          DEL CHAIN.TXT
  105.          CD\SF
  106.          GOTO LOOP
  107.          :DOOR_B
  108.          
  109.     If the WWIV door program you are using requires the use of a
  110.     configuration file, the name of the configuration file would be
  111.     added on the same line as, and after the PROGRAM NAME.  For instance,
  112.     instead of PROGRAM NAME you would need PROGRAM NAME and a blank
  113.     space followed by the name of the configuration file.      
  114.      
  115.     
  116.     USING SFWWIVDR FROM A SPITFIRE MENU
  117.     ---------------------------------
  118.     
  119.        SPITFIRE has a sysop configurable command for the Main, Message 
  120.     and File menus.  The sysop configurable command is executed through 
  121.     a batch file which corresponds to the menu it is being run from.  In
  122.     other words, SFMAIN.BAT runs the sysop configurable command from the
  123.     Main Menu, SFMESS.BAT runs the one from the Message Menu and SFFILE.BAT 
  124.     the one from the File Menu.  The commands necessary to execute SFWWIVDR 
  125.     and run the WWIV door program are set up in the batch file which 
  126.     corresponds to the menu you wish to have program run from.
  127.  
  128.        The first thing you will need to establish is which of these menus
  129.     you wish to use to run the WWIV door program.  For this purpose, 
  130.     let's assume that it is going to be set up so it can be run from the 
  131.     Main Menu.  (It should be noted the set up procedure will be the same 
  132.     regardless of which Menu you are running SFWWIVDR and the WWIV door
  133.     program from.)
  134.  
  135.        Next, you will need to decide what you wish to name the command
  136.     option and establish what security level will be required for
  137.     users of your system to be able to access this option.  Once this
  138.     is determined you will need to modify the SFMAIN.MNU file using
  139.     your favorite text editor, as long as it saves in ASCII format.
  140.     (Refer to the SPITFIRE manual for further documentation on this
  141.     if needed.  It should also be noted that if SFWWIVDR was being
  142.     set up to run from the File Menu, you would need to modify the
  143.     SFFILE.MNU file and if it was being set up to be run from the
  144.     Message Menu you would need to modify the SFMSG.MNU file.)
  145.  
  146.        Examining the default SFMAIN.MNU file, you will notice the sysop
  147.     configurable command appears as:
  148.  
  149.        <K>............. Add Your Own,,1000,@
  150.  
  151.        This will need to be replaced with a Command Character that will
  152.     be used to select the option from the menu.  It is ABSOLUTELY IMPERATIVE
  153.     that the Command Character must not duplicate an existing Command
  154.     Character for another menu option.  You will then need to include
  155.     a brief description of the WWIV door program you are running, two
  156.     commas, the security level required to access this feature, and another
  157.     comma followed by the a @.  The @ must not be changed! (For more detailed
  158.     information on modifying your SFMAIN.MNU, SFMSG.MNU or SFFILE.MNU refer
  159.     to your SPITFIRE manual.)
  160.     
  161.        <K>.... Brief Program Description,,10,@
  162.  
  163.        Now you will need to modify the corresponding batch file, SFMAIN.BAT,
  164.     so that it can be executed from the Main Menu.  Do this using your
  165.     favorite text editor, as long as it saves in ASCII format.  (Again, it
  166.     should be noted that if SFWWIVDR and the WWIV door program were being 
  167.     set up to run from the File Menu, you would need to modify the SFFILE.BAT 
  168.     file and if it was being set up to be run from the Message Menu you would 
  169.     need to modify the SFMESS.BAT file.)
  170.  
  171.        The commands you will need to include in your SFMAIN.BAT to run 
  172.     SFWWIVDR and the WWIV door program might look similar to this:
  173.    
  174.        ECHO OFF
  175.        BRK OFF
  176.        SFWWIVDR C:\SF\DIRNAME
  177.        CD\SF\DIRNAME
  178.        PROGRAM NAME 
  179.        :END
  180.        CD\SF
  181.        BRK ON
  182.  
  183.        (BRK is written and copyrighted by Solid Systems, 1985, but can 
  184.     be downloaded from Buffalo Creek's BBS as well as a number of other 
  185.     BBS systems.  BRK is not required, however, it is recommended since it
  186.     will prevent a caller using the CTRL BRK command to terminate the batch 
  187.     file, gaining access to your system at the DOS level.)
  188.  
  189.       In the above example, C:\SF\DIRNAME refers to the drive and the 
  190.     directory in which the WWIV door program files reside.  The actual
  191.     WWIV door program name would be entered where PROGRAM NAME is 
  192.     currently.   If the WWIV door program you are using requires the 
  193.     use of a configuration file, the name of the configuration file would 
  194.     be added on the same line as and after the program.  For instance,
  195.     instead of PROGRAM NAME you would need PROGRAM NAME and a blank
  196.     space followed by the name of the configuration file.      
  197.  
  198.    
  199.     SFWWIVDR ON A MULTI-NODE SYSTEM
  200.     -------------------------------
  201.    
  202.        SFWWIVDR is fully compatible for operation on a multi-node BBS.
  203.     It automatically handles any file locking and file sharing 
  204.     required during program execution.   However, the WWIV door being
  205.     used with SFWWIVDR may not have this capability.  Please refer
  206.     to the WWIV door's documentation in regard to it's multi-node
  207.     capability.
  208.     
  209.     
  210.     DISTRIBUTION
  211.     ------------
  212.  
  213.        SFWWIVDR is distributed under the shareware concept.  You are
  214.     free to distribute the SFWWIVDR program as long as it remains
  215.     unmodified and no fee is charged.  If you use this program and
  216.     find it beneficial, a fee is required.  A $1.00 fee is required
  217.     of registered SPITFIRE Sysops and a $5.00 fee is required of
  218.     all others.  
  219.     
  220.     
  221.     DISCLAIMER
  222.     ----------
  223.         
  224.          Mike Woltz and/or Buffalo Creek Software shall in no way be held 
  225.      responsible for any damage incurred while operating SFWWIVDR.  All 
  226.      responsibility lies with the user of the software.
  227.  
  228.  
  229.        The documentation for SFWWIVDR is contributed by Jacque Shipley
  230.     and The Mother Board BBS.  The shareware version of SPITFIRE 
  231.     and other SPITFIRE utilities are available for download from:
  232.  
  233.          Buffalo Creek's BBS              The Mother Board BBS
  234.           Mike Woltz, Sysop               Jacque Shipley, Sysop
  235.            (515) 225-8496                    (515) 986-3464
  236.     38000/19200/9600/2400/1200 Baud     19200/9600/2400/1200 Baud
  237.